﻿//-----------------------------------------------------------------------
// <copyright company="www.3WayWebdesign.de">
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// </copyright>
//
// <author>Michael Morbach</author>
// <email>Michael@3waywebdesign.de</email>
// <web>http://www.3waywebdesign.de</web>
//-----------------------------------------------------------------------


namespace Tww.MAF.MAFInfrastructure.Interfaces.Services
{
    #region Imports

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Threading.Tasks;
    using Tww.MAF.MAFInfrastructure.Models.UI;
    using Tww.MAF.MAFInfrastructure.Models.UI.Menu;


    #endregion

    public interface IMenuBarService : IModuleService
    {
        /// <summary>
        /// Feuert eine Nachricht an alle Abonnenten des Ereignisses, dass ein neuer Menüeintrag angeklickt wurde
        /// </summary>
        /// <param name="entry">Menüeintrag der angeklickt wurde</param>
        void PublishMenuItemClicked( IMenuTreeEntry entry );

        /// <summary>
        /// Fügt einen neuen Eintrag in den Stamm des Baummenüs mit ein
        /// </summary>
        /// <param name="entry">Neuer Menüeintrag</param>
        void AddMenuEntry( IMenuTreeEntry entry );

        /// <summary>
        /// Fügt einen neuen Eintrag als Kindelement eines bestehenden Eintrags hinzu. Wenn mehrere Einträge mit gleichem Namen existieren so wird immer der erste gefundene Treffer als Vaterelement genutzt
        /// </summary>
        /// <param name="entry">Neue Menüeintrag</param>
        /// <param name="existingEntryName">Name eines bestehenden Menüeintrages</param>
        void AttachMenuEntry( IMenuTreeEntry entry, string existingEntryName );

        /// <summary>
        /// Entfernt einen vorhandenen Menüeintrag
        /// </summary>
        /// <param name="existingEntryName">Name eines bestehenden Menüeintrages</param>
        void RemoveMenuEntry( string existingEntryName );

        /// <summary>
        /// Gibt an ob ein Eintrag mit dem angegebenen Namen im Menübaum existiert
        /// </summary>
        /// <param name="entryName">Name nach dem gesucht werden soll</param>
        /// <returns>True -> Eintrag gefunden, False -> Kein Eintrag gefunden</returns>
        bool Contains( string entryName );

        /// <summary>
        /// Gibt alle Wurzeleinträge aus der Baumstruktur zurück
        /// </summary>
        /// <returns>Liste mit Wurzeleinträge</returns>
        List<IMenuTreeEntry> GetRootEntries();

        /// <summary>
        /// Leert die Baumstruktur
        /// </summary>
        void ClearTree();
    }
}
